Creating the CSV file

A .csv file containing loop information needs to be created before the Action Object can be added to the CSense Runtime Manager for deployment. This Comma Separated Values (.csv) file will define the information required for the loops, such as the name and identity of the loop in the control system, where the tags will read data from, what the process variable and set point limits are, and the scales to be used on the graphs.

Required format

Create the .csv file is the following format:

Headers

Values (separated by commas)

The required headers are listed in the loop definitions file table.
The order of the data must match the order of the headers.

Examples

Example 1: Importing tags from different databases

Proficy Historian:

These tags will be read in from a Proficy Historian.

Optimized Database:

These tags are read in from an Optimized Database. The tags appear in the Fields table in the Optimized Database.

Example 2: Comparing .csv files for deploying and redeploying loops

Deploying loops

When deploying an Action Object, leave the LoopId blank as it will be automatically generated on deployment of the Action Object.

Redeploying loops

In order to redeploy a loop, you need to know the LoopID. This will have been automatically generated on the initial deployment of the loop in an Action Object.

Obtain this LoopID by:

Exporting the Action Object which contained the original loop.
When exporting that Action Object, save the .csv file for the contained loops.
Open the saved .csv file to read the LoopId of the required loop. The LoopID will be used for redeployment.
Enter the LoopID in the LoopID column in the .csv file. Make any other required adjustments in the .csv file for that loop for redeployment, such as changing the limit values, enabling or disabling tags, etc.
In the example below, note that the LoopIDs are entered in the LoopID column for the two redeployed loops (LoopIDs 211 and 215), and the LoopID column is empty for loops to be deployed the first time.

Example 3: Writing loop statistics and loop configuration to Historian tags

The loop definitions .csv file can be used to specify loop statistics and loop configuration that should be written to Proficy Historian tags when the Action Object is added to the CSense Runtime Manager for deployment.

LoopID,LoopName,LowerSPOffset,UpperSPOffset,LowerPVLimit,UpperPVLimit,SamplingPeriod,TagSP,TagPV,TagMV,TagP,TagI,TagD,TagF,TagVV,TagWW,TagXX,TagYY,TagZZ,TagPEnabled,TagIEnabled,TagDEnabled,TagFEnabled,LoopDescription,LoopPriority,Plant,Section,Group,OutLowerSPOffset,OutUpperSPOffset,OutLowerPVLimit,OutUpperPVLimit,OutConfiguration,OutValuePercentageManual,OutValuePercentageManualLLExceeded,OutValuePercentageManualULExceeded,OutValuePercentageAuto,OutValuePercentageAutoLLExceeded,OutValuePercentageAutoULExceeded,OutValuePercentageCascade,OutValuePercentageCascadeLLExceeded,OutValuePercentageCascadeULExceeded,OutValuePercentageShutdown,OutValuePercentageShutdownLLExceeded,OutValuePercentageShutdownULExceeded,OutValueNumberOfSamples,OutValuePercentageControlOn,OutValuePercentageControllerOutput,OutValuePercentageNotUtilized,OutValuePercentageMVSaturation,OutValueOverallPerformance,OutValueMovementIndex,OutValueControlAmplitude,OutValueReverseIndex,OutValueReverseAmplitude,OutValueIntegratedSum,OutValueAverage,OutValueStdDeviation,OutValuePercentagePVVariance,OutValuePVVariability,OutValuePercentageGoodQuality,OutValuePIDFChanges,OutValueAverageAbsoluteError,OutValueFFTPeriodPeak1,OutValueFFTPeriodPeak2,OutValueFFTPeriodPeak3,OutValueFFTPowerPercentagePeak1,OutValueFFTPowerPercentagePeak2,OutValueFFTPowerPercentagePeak3,OutValuePercentageLimitsExceeded,OutValuePerformanceIndex,OutValuePValueStartOfReport,OutValueIValueStartOfReport,OutValueDValueStartOfReport,OutValueFValueStartOfReport,OutValuePValueEndOfReport,OutValueIValueEndOfReport,OutValueDValueEndOfReport,OutValueFValueEndOfReport
,HistorianLoop01,1,50,2,500,15,IO/WRITE/Loop1_SP,IO/WRITE/Loop1_PV,IO/WRITE/Loop1_MV,IO/WRITE/Loop1_P,IO/WRITE/Loop1_I,IO/WRITE/Loop1_D,,IO/WRITE/Loop1_WW,,,,,1,1,1,0,Loop saving to Proficy Historian 01,High,USA Plant,Section A,Motors,Loop01_OutLowerSPOffset,Loop01_OutUpperSPOffset,Loop01_OutLowerPVLimit,Loop01_OutUpperPVLimit,Loop01_OutConfiguration,Loop01_OutValuePercentageManual,Loop01_OutValuePercentageManualLLExceeded,Loop01_OutValuePercentageManualULExceeded,Loop01_OutValuePercentageAuto,Loop01_OutValuePercentageAutoLLExceeded,Loop01_OutValuePercentageAutoULExceeded,Loop01_OutValuePercentageCascade,Loop01_OutValuePercentageCascadeLLExceeded,Loop01_OutValuePercentageCascadeULExceeded,Loop01_OutValuePercentageShutdown,Loop01_OutValuePercentageShutdownLLExceeded,Loop01_OutValuePercentageShutdownULExceeded,Loop01_OutValueNumberOfSamples,Loop01_OutValuePercentageControlOn,Loop01_OutValuePercentageControllerOutput,Loop_1_OutValuePercentageNotUtilized,Loop01_OutValuePercentageMVSaturation,Loop01_OutValueOverallPerformance,Loop01_OutValueMovementIndex,Loop01_OutValueControlAmplitude,Loop01_OutValueReverseIndex,Loop01_OutValueReverseAmplitude,Loop01_OutValueIntegratedSum,Loop01_OutValueAverage,Loop01_OutValueStdDeviation,Loop_1_OutValuePercentagePVVariance,Loop_1_OutValuePVVariability,Loop01_OutValuePercentageGoodQuality,Loop01_OutValuePIDFChanges,Loop01_OutValueAverageAbsoluteError,Loop01_OutValueFFTPeriodPeak1,Loop01_OutValueFFTPeriodPeak2,Loop01_OutValueFFTPeriodPeak3,Loop01_OutValueFFTPowerPercentagePeak1,Loop01_OutValueFFTPowerPercentagePeak2,Loop01_OutValueFFTPowerPercentagePeak3,Loop01_OutValuePercentageLimitsExceeded,Loop01_OutValuePerformanceIndex,Loop01_OutValuePValueStartOfReport,Loop01_OutValueIValueStartOfReport,Loop01_OutValueDValueStartOfReport,Loop01_OutValueFValueStartOfReport,Loop01_OutValuePValueEndOfReport,Loop01_OutValueIValueEndOfReport,Loop01_OutValueDValueEndOfReport,Loop01_OutValueFValueEndOfReport
,HistorianLoop02,1,50,2,500,15,IO/WRITE/Loop2_SP,IO/WRITE/Loop2_PV,IO/WRITE/Loop2_MV,IO/WRITE/Loop2_P,IO/WRITE/Loop2_I,IO/WRITE/Loop2_D,,IO/WRITE/Loop2_WW,,,,,1,1,1,0,Loop saving to Proficy Historian 01,High,USA Plant,Section A,Motors,Loop02_OutLowerSPOffset,Loop02_OutUpperSPOffset,Loop02_OutLowerPVLimit,Loop02_OutUpperPVLimit,Loop02_OutConfiguration,Loop02_OutValuePercentageManual,Loop02_OutValuePercentageManualLLExceeded,Loop02_OutValuePercentageManualULExceeded,Loop02_OutValuePercentageAuto,Loop02_OutValuePercentageAutoLLExceeded,Loop02_OutValuePercentageAutoULExceeded,Loop02_OutValuePercentageCascade,Loop02_OutValuePercentageCascadeLLExceeded,Loop02_OutValuePercentageCascadeULExceeded,Loop02_OutValuePercentageShutdown,Loop02_OutValuePercentageShutdownLLExceeded,Loop02_OutValuePercentageShutdownULExceeded,Loop02_OutValueNumberOfSamples,Loop02_OutValuePercentageControlOn,Loop02_OutValuePercentageControllerOutput,Loop_1_OutValuePercentageNotUtilized,Loop02_OutValuePercentageMVSaturation,Loop02_OutValueOverallPerformance,Loop02_OutValueMovementIndex,Loop02_OutValueControlAmplitude,Loop02_OutValueReverseIndex,Loop02_OutValueReverseAmplitude,Loop02_OutValueIntegratedSum,Loop02_OutValueAverage,Loop02_OutValueStdDeviation,Loop_1_OutValuePercentagePVVariance,Loop_1_OutValuePVVariability,Loop02_OutValuePercentageGoodQuality,Loop02_OutValuePIDFChanges,Loop02_OutValueAverageAbsoluteError,Loop02_OutValueFFTPeriodPeak1,Loop02_OutValueFFTPeriodPeak2,Loop02_OutValueFFTPeriodPeak3,Loop02_OutValueFFTPowerPercentagePeak1,Loop02_OutValueFFTPowerPercentagePeak2,Loop02_OutValueFFTPowerPercentagePeak3,Loop02_OutValuePercentageLimitsExceeded,Loop02_OutValuePerformanceIndex,Loop02_OutValuePValueStartOfReport,Loop02_OutValueIValueStartOfReport,Loop02_OutValueDValueStartOfReport,Loop02_OutValueFValueStartOfReport,Loop02_OutValuePValueEndOfReport,Loop02_OutValueIValueEndOfReport,Loop02_OutValueDValueEndOfReport,Loop02_OutValueFValueEndOfReport
,HistorianLoop03,1,50,2,500,15,IO/WRITE/Loop3_SP,IO/WRITE/Loop3_PV,IO/WRITE/Loop3_MV,IO/WRITE/Loop3_P,IO/WRITE/Loop3_I,IO/WRITE/Loop3_D,,IO/WRITE/Loop3_WW,,,,,1,1,1,0,Loop saving to Proficy Historian 01,High,USA Plant,Section A,Motors,Loop03_OutLowerSPOffset,Loop03_OutUpperSPOffset,Loop03_OutLowerPVLimit,Loop03_OutUpperPVLimit,Loop03_OutConfiguration,Loop03_OutValuePercentageManual,Loop03_OutValuePercentageManualLLExceeded,Loop03_OutValuePercentageManualULExceeded,Loop03_OutValuePercentageAuto,Loop03_OutValuePercentageAutoLLExceeded,Loop03_OutValuePercentageAutoULExceeded,Loop03_OutValuePercentageCascade,Loop03_OutValuePercentageCascadeLLExceeded,Loop03_OutValuePercentageCascadeULExceeded,Loop03_OutValuePercentageShutdown,Loop03_OutValuePercentageShutdownLLExceeded,Loop03_OutValuePercentageShutdownULExceeded,Loop03_OutValueNumberOfSamples,Loop03_OutValuePercentageControlOn,Loop03_OutValuePercentageControllerOutput,Loop_1_OutValuePercentageNotUtilized,Loop03_OutValuePercentageMVSaturation,Loop03_OutValueOverallPerformance,Loop03_OutValueMovementIndex,Loop03_OutValueControlAmplitude,Loop03_OutValueReverseIndex,Loop03_OutValueReverseAmplitude,Loop03_OutValueIntegratedSum,Loop03_OutValueAverage,Loop03_OutValueStdDeviation,Loop_1_OutValuePercentagePVVariance,Loop_1_OutValuePVVariability,Loop03_OutValuePercentageGoodQuality,Loop03_OutValuePIDFChanges,Loop03_OutValueAverageAbsoluteError,Loop03_OutValueFFTPeriodPeak1,Loop03_OutValueFFTPeriodPeak2,Loop03_OutValueFFTPeriodPeak3,Loop03_OutValueFFTPowerPercentagePeak1,Loop03_OutValueFFTPowerPercentagePeak2,Loop03_OutValueFFTPowerPercentagePeak3,Loop03_OutValuePercentageLimitsExceeded,Loop03_OutValuePerformanceIndex,Loop03_OutValuePValueStartOfReport,Loop03_OutValueIValueStartOfReport,Loop03_OutValueDValueStartOfReport,Loop03_OutValueFValueStartOfReport,Loop03_OutValuePValueEndOfReport,Loop03_OutValueIValueEndOfReport,Loop03_OutValueDValueEndOfReport,Loop03_OutValueFValueEndOfReport
,HistorianLoop04,1,50,2,500,15,IO/WRITE/Loop4_SP,IO/WRITE/Loop4_PV,IO/WRITE/Loop4_MV,IO/WRITE/Loop4_P,IO/WRITE/Loop4_I,IO/WRITE/Loop4_D,,IO/WRITE/Loop4_WW,,,,,1,1,1,0,Loop saving to Proficy Historian 01,High,USA Plant,Section A,Motors,Loop04_OutLowerSPOffset,Loop04_OutUpperSPOffset,Loop04_OutLowerPVLimit,Loop04_OutUpperPVLimit,Loop04_OutConfiguration,Loop04_OutValuePercentageManual,Loop04_OutValuePercentageManualLLExceeded,Loop04_OutValuePercentageManualULExceeded,Loop04_OutValuePercentageAuto,Loop04_OutValuePercentageAutoLLExceeded,Loop04_OutValuePercentageAutoULExceeded,Loop04_OutValuePercentageCascade,Loop04_OutValuePercentageCascadeLLExceeded,Loop04_OutValuePercentageCascadeULExceeded,Loop04_OutValuePercentageShutdown,Loop04_OutValuePercentageShutdownLLExceeded,Loop04_OutValuePercentageShutdownULExceeded,Loop04_OutValueNumberOfSamples,Loop04_OutValuePercentageControlOn,Loop04_OutValuePercentageControllerOutput,Loop_1_OutValuePercentageNotUtilized,Loop04_OutValuePercentageMVSaturation,Loop04_OutValueOverallPerformance,Loop04_OutValueMovementIndex,Loop04_OutValueControlAmplitude,Loop04_OutValueReverseIndex,Loop04_OutValueReverseAmplitude,Loop04_OutValueIntegratedSum,Loop04_OutValueAverage,Loop04_OutValueStdDeviation,Loop_1_OutValuePercentagePVVariance,Loop_1_OutValuePVVariability,Loop04_OutValuePercentageGoodQuality,Loop04_OutValuePIDFChanges,Loop04_OutValueAverageAbsoluteError,Loop04_OutValueFFTPeriodPeak1,Loop04_OutValueFFTPeriodPeak2,Loop04_OutValueFFTPeriodPeak3,Loop04_OutValueFFTPowerPercentagePeak1,Loop04_OutValueFFTPowerPercentagePeak2,Loop04_OutValueFFTPowerPercentagePeak3,Loop04_OutValuePercentageLimitsExceeded,Loop04_OutValuePerformanceIndex,Loop04_OutValuePValueStartOfReport,Loop04_OutValueIValueStartOfReport,Loop04_OutValueDValueStartOfReport,Loop04_OutValueFValueStartOfReport,Loop04_OutValuePValueEndOfReport,Loop04_OutValueIValueEndOfReport,Loop04_OutValueDValueEndOfReport,Loop04_OutValueFValueEndOfReport
,HistorianLoop05,1,50,2,500,15,IO/WRITE/Loop5_SP,IO/WRITE/Loop5_PV,IO/WRITE/Loop5_MV,IO/WRITE/Loop5_P,IO/WRITE/Loop5_I,IO/WRITE/Loop5_D,,IO/WRITE/Loop5_WW,,,,,1,1,1,0,Loop saving to Proficy Historian 01,High,USA Plant,Section A,Motors,Loop05_OutLowerSPOffset,Loop05_OutUpperSPOffset,Loop05_OutLowerPVLimit,Loop05_OutUpperPVLimit,Loop05_OutConfiguration,Loop05_OutValuePercentageManual,Loop05_OutValuePercentageManualLLExceeded,Loop05_OutValuePercentageManualULExceeded,Loop05_OutValuePercentageAuto,Loop05_OutValuePercentageAutoLLExceeded,Loop05_OutValuePercentageAutoULExceeded,Loop05_OutValuePercentageCascade,Loop05_OutValuePercentageCascadeLLExceeded,Loop05_OutValuePercentageCascadeULExceeded,Loop05_OutValuePercentageShutdown,Loop05_OutValuePercentageShutdownLLExceeded,Loop05_OutValuePercentageShutdownULExceeded,Loop05_OutValueNumberOfSamples,Loop05_OutValuePercentageControlOn,Loop05_OutValuePercentageControllerOutput,Loop_1_OutValuePercentageNotUtilized,Loop05_OutValuePercentageMVSaturation,Loop05_OutValueOverallPerformance,Loop05_OutValueMovementIndex,Loop05_OutValueControlAmplitude,Loop05_OutValueReverseIndex,Loop05_OutValueReverseAmplitude,Loop05_OutValueIntegratedSum,Loop05_OutValueAverage,Loop05_OutValueStdDeviation,Loop_1_OutValuePercentagePVVariance,Loop_1_OutValuePVVariability,Loop05_OutValuePercentageGoodQuality,Loop05_OutValuePIDFChanges,Loop05_OutValueAverageAbsoluteError,Loop05_OutValueFFTPeriodPeak1,Loop05_OutValueFFTPeriodPeak2,Loop05_OutValueFFTPeriodPeak3,Loop05_OutValueFFTPowerPercentagePeak1,Loop05_OutValueFFTPowerPercentagePeak2,Loop05_OutValueFFTPowerPercentagePeak3,Loop05_OutValuePercentageLimitsExceeded,Loop05_OutValuePerformanceIndex,Loop05_OutValuePValueStartOfReport,Loop05_OutValueIValueStartOfReport,Loop05_OutValueDValueStartOfReport,Loop05_OutValueFValueStartOfReport,Loop05_OutValuePValueEndOfReport,Loop05_OutValueIValueEndOfReport,Loop05_OutValueDValueEndOfReport,Loop05_OutValueFValueEndOfReport

The properties to write to Historian tags are optional. If any of them are used, however, they must all be specified and in the correct order. Unused properties are kept empty, as in ',,'.

If the above loop definition file example did not write to Historian tags, it would look like this: